home *** CD-ROM | disk | FTP | other *** search
/ Experimental BBS Explossion 3 / Experimental BBS Explossion III.iso / others / ngz.zip / NGZ.DOC next >
Text File  |  1993-05-14  |  6KB  |  123 lines

  1.  
  2.  
  3.  
  4.                     NGZ 1.0 - Norton Guide Disassembler
  5.                     -----------------------------------
  6.  
  7.                     Contents:   Purpose         p. 1
  8.                                 Format
  9.                                 Description
  10.                                 Using NGZ
  11.                                 Files           p. 2
  12.                                 Credits
  13.                                 Copyright
  14.                                 Eof             p. 2
  15.  
  16.  
  17. Purpose             To disassemble or report on NG v1.0 database files.
  18.  
  19.  
  20. Format              NGZ ngfile.ng [/?][/R | /Poffset[/Q]]
  21.                     /?  Brief help text
  22.                     /R  Report only (.RPT)
  23.                     /Poffset  Partial disassembly at _hex_ file offset.
  24.                         E.g. /P1A44B
  25.                         Run a report first to get the offset.
  26.                         Don't use this on menu or short-to-short strucs.
  27.                     /Q  Suppress screen output (Note: disables Ctrl-C)
  28.  
  29.  
  30. Description         NGZ does what other NG disassemblers do, but it uses
  31.                     a different, and somewhat faster, algorithm.
  32.                     It can resolve all !Seealso references to other files
  33.                     without aborting with an 'out of memory' error, and
  34.                     resolve all !File references. Not by recursively read-
  35.                     ing (and decrypting) the .NG byte by byte, but by in-
  36.                     dexing and processing the file sequentially.
  37.  
  38.                     The NGZ source includes a near-complete description of
  39.                     the NG file format. More details on the format and on
  40.                     the disassembly algorithm in a note in NGZ.GLO.
  41.  
  42.  
  43. Using NGZ           Type NGZ filename.NG for a complete disassembly, i.e.
  44.                     a number of FILEnnn.ASC, a FILE.LCF, a FILE.MAK, and
  45.                     a FILE.RPT, = source, an NGML link control file, a
  46.                     MAKE script file, and a report file with brief statis-
  47.                     tics, a file index, and entries on any unresolved see-
  48.                     alsos (these were ignored at compilation time and can-
  49.                     not be resolved; they'll appear in the .ASC as a ref-
  50.                     erence to FILE999.NGO).
  51.  
  52.                          +----------------------------------------+
  53.                            NOTE: Existing .ASC .LCF .MAK and .RPT
  54.                                    files will be overwritten
  55.                          +----------------------------------------+
  56.  
  57.                     During disassembly, NGZ outputs a simple odometer:
  58.                     file number, 's' for a short struc, 'l' for a long,
  59.                     and 'f' for a !File entry.
  60.  
  61.                     You should note that the /R, /P, and /Q switches are
  62.                     last minute additions. Despite what the brief help text
  63.                     says, you _can_ use the /P switch on a short-to-short
  64.                     structure, but it will result in some garbage at the
  65.                     !File entries (in fact, it can be run on any offset
  66.                     since it bypasses all indexing, but aborts if offset
  67.                     doesn't point to a short or long structure).
  68.  
  69.                     If you want to dig deeper into the structure headers,
  70.                     e.g. if attempting to restore a currupt file, NGZ.INC
  71.                     has some procedures that may be useful. However, these
  72.                     are not implemented in NGZ.EXE.
  73.  
  74.  
  75. Files               NGZ.PAS  Pascal source.
  76.                     NGZ.GLO  Global definitions.
  77.                     NGZ.INC  Support routines.
  78.                     NGZ.DOC  This file.
  79.                     NGZ.EXE  The executable.
  80.  
  81.                     TP6 was used for compilation but TP4+ should work
  82.                     as well.
  83.  
  84.  
  85. Credits             NGZ is my own work but I doubt it would have reached
  86.                     the .exe state without a glance or two in the follow-
  87.                     ing 2 programs (though my knowledge of C is limited
  88.                     to a very few WORDs):
  89.  
  90.                     DIS_NG.C - Norton Guide Disassembler
  91.                     Written by Donald C. Mullen, August 28, 1988
  92.                     UUCP: ...!ecsvax!dukeac!don
  93.                     Corrections and additions June 1990 by Henrik Sloth
  94.                     (based on NG_SPLIT.C v1.1 by John C. Gordan)
  95.  
  96.                     NGDUMP.PAS v1.0 - Norton Guide Decompiler
  97.                     Copyright 1989 J.P.Pedersen, 1990 E.v.Asperen
  98.                     Eelco van Asperen
  99.                     evas@cs.eur.nl (asperen@hroeur5.bitnet)
  100.                     Erasmus University Rotterdam, The Netherlands
  101.                     (based on NGCLONE.PAS - an NG.EXE clone by J.P.
  102.                     Pedersen a.o.)
  103.  
  104.  
  105. Copyright           NGZ is in the public domain. You're free to use, copy,
  106.                     and distribute the five NGZ files on condition that the
  107.                     files are not separated or modified and that no fee
  108.                     exceeding distribution costs is charged.
  109.  
  110.                     To my knowledge, the NG file format was never placed in
  111.                     the public domain; an American company is currently mar-
  112.                     keting an NG update.
  113.  
  114.                     And you should, of course, take into consideration any
  115.                     applicable copyright laws before using NGZ.
  116.  
  117.  
  118. May 1993,
  119. Morten Elling
  120. DK-8000 Aarhus C.
  121.  
  122.  
  123.